Schnittstellen & API
Admin Power Pack stellt die folgenden Schnittstellen zur Verwendung durch Drittsysteme bereit. Übergreifende Grundlagen — Konzepte, Erreichbarkeit und Authentifizierung der Fluxpunkt-Module — beschreibt der Artikel Schnittstellen & APIs.
Schnittstellen im Überblick
| Schnittstelle | Typ | Authentifizierung |
|---|---|---|
| XML-RPC-Befehle | XML-RPC (HTTPS) | STARFACE-Benutzer mit Administrationsrecht |
| Ereignisse | FpEvents (STARFACE-interner Ereignisbus) | keine eigene — Zugriff über EventBridge oder ein eigenes Modul |
| Export-/Import-Formate | Dateiformate (ZIP/CSV) | Moduloberfläche, STARFACE-Benutzer mit Administrationsrecht |
| HTTP-API (API-Tokens) | REST/JSON (HTTPS) | statisches API-Token (Authorization: Bearer) — ab der nächsten Modulversion |
Voraussetzung für alle Schnittstellen ist eine aktive, lizenzierte Modulkonfiguration.
Die zwölf Wartungsbefehle und die zwei Systemaktionen (STARFACE-Neustart und -Update)
stehen gleichwertig auf mehreren Wegen bereit: als native XML-RPC-Methoden für externe
Aufrufer, als Steuerereignisse für andere Module und — ab der nächsten Modulversion — über
die HTTP-API mit statischen API-Tokens für Drittsysteme ohne
STARFACE-Benutzerkonto; die Wartungsbefehle zusätzlich als zeitgesteuerte „Geplante
Aktionen", die Systemaktionen mit eigener Zeitplanung (executeAt). Alle Wege münden in
dieselbe Ausführung; den Abschluss meldet je Wartungsaktion ein eigenes Ereignis — die
Systemaktionen senden keines.
Referenz
XML-RPC-Befehle
meldet die zwölf Wartungsfunktionen des Tabs
Ereignisse
tauscht Ereignisse („FpEvents") mit anderen Fluxpunkt-Modulen aus: Es empfängt
Export-/Import-Formate
exportiert Ruflisten und Adressbücher in dokumentierten, wieder einlesbaren
HTTP-API (API-Tokens)
stellt die Wartungsbefehle und Systemaktionen des Tabs